Platform Explorer / Nuxeo Platform 2023.9

Extension point environment

Documentation

Extension point to contribute environment configuration.

Available options are: - name: comma-separated string attribute used as the environment parameters scope. It can be empty to set environment parameters common to all commands, equal to a command name to set parameters for that command only, or equal to a command line to set parameters common to all commands using that command line. You can associate multiple commands using a comma as separator.

- workingDirectory: the Folder when command should be executed. Default is the system temporary folder.

- parameters/parameter

CommandLine contribution example:

    <environment name="aCommandName,aCommandLine">
        <parameters>
            <parameter name="SOME_VAR">some value</parameter>
        </parameters>
    </environment>

Contribution Descriptors

  • Class: org.nuxeo.ecm.platform.commandline.executor.service.EnvironmentDescriptor

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

  • nuxeo-platform-commandline-executor-2023.9.10.jar /OSGI-INF/commandline-default-contrib.xml
    <?xml version='1.0' encoding='UTF-8'?>
    <extension point="environment" target="org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent">
        <documentation>Default environment parameters.</documentation>
        <environment>
          <parameters>
            <!-- TMPDIR is the canonical Unix environment variable specified in various Unix and similar standards -->
            <!-- TMP, TEMP and TEMPDIR are alternatively used by non-POSIX OS or non-standard programs -->
            <!-- Windows/DOS programs randomly use TMP or TEMP environment variables -->
            <parameter name="TMPDIR">********</parameter>
            <parameter name="TMP">********</parameter>
            <parameter name="TEMP">********</parameter>
            <parameter name="TEMPDIR">********</parameter>
          </parameters>
        </environment>
      </extension>
  • nuxeo-binary-metadata-2023.9.10.jar /OSGI-INF/binary-metadata-default-contrib.xml
    <?xml version='1.0' encoding='UTF-8'?>
    <extension point="environment" target="org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent">
        <environment name="exiftool">
          <parameters>
            <!-- See http://search.cpan.org/dist/PAR/lib/PAR.pm#Notes -->
            <parameter name="PAR_GLOBAL_TMPDIR">********</parameter>
            <!-- set PAR_CLEAN cleaning PAR_GLOBAL_TEMP after execution -->
            <!-- <parameter name="PAR_CLEAN">0</parameter> -->
          </parameters>
        </environment>
      </extension>